get /cloud/credentials/{credName}
Describe Credentials (describeCredentials)
Describes the cloud credentials.
Path parameters
credName (required)
Path Parameter — Cloud credentials name
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Return type
CredentialsDescription
|
id (optional) |
CredentialsId
|
||||||
|
cloudProvider (optional) |
CloudProvider Cloud provider - AWS, Azure or Gcp |
||||||
|
operationLinks (optional) |
OperationLink List of Links to CE Operations
|
Example data
Content-Type: application/json
{
"id": {
"value": "vm-1",
"_type": "CredentialsId"
},
"cloudProvider": "Aws",
"OperationLinks" : [ {
"rel: "describe","
"href: "/velostrata/api/v35/credentials/credId2"
"httpVerb: "GET"
},
{
"rel: "delete","
"href: "/velostrata/api/v35/credentials/credId2"
"httpVerb: "DELETE"
},
{
"rel: "reconfigure","
"href: "href: "/velostrata/api/v35/credentials/credId2"
"httpVerb: "PUT"
}
} ]
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK CredentialsDescription
Default
Error ErrorInfo
|
errorCode (optional) |
String |
|
url(optional) |
String |
|
message (optional) |
String |